home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkPrefItem.z / VkPrefItem
Encoding:
Text File  |  1998-10-20  |  8.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkPPPPrrrreeeeffffIIIItttteeeemmmm((((3333xxxx))))                                                  VVVVkkkkPPPPrrrreeeeffffIIIItttteeeemmmm((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkPrefItem - Abstract class that supports preference items
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkComponent : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkPrefItem.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  19.            virtual int type(void);
  20.            virtual Boolean changed(void);
  21.            virtual Dimension labelHeight(void);
  22.            virtual Dimension baseHeight(void);
  23.            virtual void setLabelHeight(Dimension height);
  24.            virtual void setBaseHeight(Dimension height);
  25.            Widget labelWidget(void);
  26.  
  27.  
  28.    AAAAccccttttiiiivvvvaaaattttiiiinnnngggg////DDDDeeeeaaaaccccttttiiiivvvvaaaattttiiiinnnngggg
  29.            virtual void activate();
  30.            virtual void deactivate();
  31.  
  32.  
  33. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  34.           VkPrefItem is an abstract class that supports easy-to-create
  35.           preference panels. The classes derived from VkPrefItem form a simple
  36.           toolkit that creates preference panels, typically placed in a
  37.           dialog.  When creating a preference pane using the VkPref classes
  38.           one does not normally pay much attention to layout, but allows the
  39.           VkPref classes to create a layout automatically. The VkPref classes
  40.           provide users the ability to cancel any operation at any time,
  41.           reverting all preferences to their previous values. Automatically.
  42.           Programmers who use the preference classes do not have to deal with
  43.           callbacks or data retrieval on a per-widget basis, but instead allow
  44.           the VkPref classes to handle all intermediate states transparently.
  45.           Applications simply look at the final values of all preferences to
  46.           see what has changed when the user applies the preferences.
  47.  
  48.           Preference panels are organized around from the VkPrefDialog class,
  49.           the VkPrefList class, and the VkPrefGroup class. See man pages for
  50.           those classes for examples of how to create preference panels.
  51.  
  52.  
  53.  
  54. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  55.    VVVVkkkkPPPPrrrreeeeffffIIIItttteeeemmmm(((())))
  56.            virtual void ~VkPrefItem(void);
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkPPPPrrrreeeeffffIIIItttteeeemmmm((((3333xxxx))))                                                  VVVVkkkkPPPPrrrreeeeffffIIIItttteeeemmmm((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           The VkPrefItem destructor destroys the companion label widget, and
  75.           frees strings created for the base and label widget names.
  76.  
  77.    ttttyyyyppppeeee(((())))
  78.            virtual int type(void);
  79.  
  80.  
  81.           The type method is overridden by subclasses to return the true
  82.           preference item type: PI_group, PI_list, PI_radio, PI_text,
  83.           PI_toggle, PI_option, PI_custom, PI_empty, PI_label, or
  84.           PI_separator.  These correspond to the subclasses VkPrefGroup,
  85.           VkPrefList, VkPrefRadio, VkPrefText, VkPrefToggle, VkPrefOption,
  86.           VkPrefCustom, VkPrefEmpty, VkPrefLabel, and VkPrefSeparator,
  87.           respectively.
  88.  
  89.    aaaaccccttttiiiivvvvaaaatttteeee(((())))
  90.            void activate();
  91.            void deactivate();
  92.  
  93.  
  94.           Activate and deactivate will sensitize and desensitize,
  95.           respectively, the preference object.  The default state is
  96.           sensitive.
  97.  
  98.    cccchhhhaaaannnnggggeeeedddd(((())))
  99.            virtual Boolean changed(void);
  100.  
  101.  
  102.           This method indicates whether the current value differs from the
  103.           real value.  Applications may want to call this method for
  104.           preference objects when to test whether the user has actually
  105.           changed the value.  Typically, a VkPrefDialog is used and
  106.           applications use this method in the apply callback.
  107.  
  108.    iiiissssCCCCoooonnnnttttaaaaiiiinnnneeeerrrr(((())))
  109.            virtual Boolean isContainer(void);
  110.  
  111.  
  112.           Indicates whether this object contains other preference objects
  113.           (e.g. VkPrefList, VkPrefGroup).
  114.  
  115.    llllaaaabbbbeeeellllHHHHeeeeiiiigggghhhhtttt(((())))
  116.            virtual Dimension labelHeight(void);
  117.            virtual void setLabelHeight(Dimension height);
  118.  
  119.  
  120.           The labelHeight method returns the height, in pixels, of the label
  121.           widget.  The setLabelHeight method changes the height.
  122.  
  123.    bbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt(((())))
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkPPPPrrrreeeeffffIIIItttteeeemmmm((((3333xxxx))))                                                  VVVVkkkkPPPPrrrreeeeffffIIIItttteeeemmmm((((3333xxxx))))
  137.  
  138.  
  139.  
  140.            virtual Dimension baseHeight(void);
  141.            virtual void setBaseHeight(Dimension height);
  142.  
  143.  
  144.           The baseHeight method returns the height, in pixels, of the base
  145.           widget.  The setBaseHeight method changes the height.
  146.  
  147.    llllaaaabbbbeeeellllWWWWiiiiddddggggeeeetttt(((())))
  148.            Widget labelWidget(void);
  149.  
  150.  
  151.           Returns the label widget for the preference object.  If there is no
  152.           label widget, NULL is returned.
  153.  
  154. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  155.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  156.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  157.           setDefaultResources(), getResources(), manage(), unmanage(),
  158.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  159.  
  160.  
  161.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  162.           callCallbacks(), addCallback(), removeCallback(),
  163.           removeAllCallbacks(),
  164.  
  165. KKKKNNNNOOOOWWWWNNNN DDDDEEEERRRRIIIIVVVVEEEEDDDD CCCCLLLLAAAASSSSSSSSEEEESSSS
  166.      VkPrefGroup, VkPrefList, VkPrefRadio, VkPrefText, VkPrefToggle,
  167.      VkPrefOption, VkPrefCustom, VkPrefEmpty, VkPrefLabel, VkPrefSeparator,
  168.  
  169. KKKKNNNNOOOOWWWWNNNN CCCCLLLLAAAASSSSSSSSEEEESSSS TTTTHHHHAAAATTTT UUUUSSSSEEEE TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  170.      VkPrefDialog, VkPrefGroup, VkPrefList, VkPrefRadio,
  171.  
  172. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  173.      VkComponent, VkPrefDialog, VkPrefGroup, VkPrefList, VkPrefRadio
  174.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  175.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  176.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  177.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.